home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 1 / Amiga Tools.iso / egs-tools / egs_dev-disk / egsdocs / egsrequest.doc < prev    next >
Encoding:
Text File  |  1994-06-06  |  11.1 KB  |  476 lines
  1. TABLE OF CONTENTS
  2.  
  3. egsrequest.library/ER_CancelRequest
  4. egsrequest.library/ER_ChangeRequestPos
  5. egsrequest.library/ER_ChangeRequestSize
  6. egsrequest.library/ER_CreateFileReq
  7. egsrequest.library/ER_CreateFontReq
  8. egsrequest.library/ER_CreateReqContext
  9. egsrequest.library/ER_CreateScrModeReq
  10. egsrequest.library/ER_CreateSimpleReq
  11. egsrequest.library/ER_DeleteReqContext
  12. egsrequest.library/ER_DeleteRequest
  13. egsrequest.library/ER_DoRequest
  14. egsrequest.library/ER_FindRequest
  15. egsrequest.library/ER_IterateRequest
  16. egsrequest.library/ER_OpenRequest
  17. egsrequest.library/ER_PutValuesInFileReq
  18. egsrequest.library/ER_PutValuesInFontReq
  19. egsrequest.library/ER_PutValuesInScrModeReq
  20. egsrequest.library/ER_CancelRequest       egsrequest.library/ER_CancelRequest
  21.  
  22.    NAME
  23.     ER_CancelRequest -- cancels pending request
  24.  
  25.    SYNOPSIS
  26.     ER_CancelRequest(req)
  27.                      A0
  28.  
  29.     void ER_CancelRequest(ER_RequestPtr)
  30.  
  31.    FUNCTION
  32.     Cancels a pending request. The associated window is closed. The
  33.     requester structure is NOT freed. If the requester is not currently
  34.     in use this is a no operation.
  35.  
  36.    INPUTS
  37.     req    : request to be canceled
  38.  
  39.    RESULT
  40.  
  41.    SEE ALSO
  42.  
  43.  
  44. egsrequest.library/ER_ChangeRequestPos egsrequest.library/ER_ChangeRequestPos
  45.  
  46.    NAME
  47.     ER_ChangeRequestPos -- Moves a requester
  48.  
  49.    SYNOPSIS
  50.     ER_ChangeRequestPos(req, x, y)
  51.                         A0   D0 D1
  52.  
  53.     void ER_ChangeRequestPos(ER_RequestPtr, WORD, WORD)
  54.  
  55.    FUNCTION
  56.     Moves a requester to the absolute location x/y. If the requester is
  57.     not currently open, it will open up on this position the next time it
  58.     is used.
  59.  
  60.    INPUTS
  61.     req    : requester to be moved
  62.     x,y    : absolute destination location
  63.  
  64.    RESULT
  65.  
  66.    SEE ALSO
  67.  
  68.  
  69. egsrequest.library/ER_ChangeRequestSizeegsrequest.library/ER_ChangeRequestSize
  70.  
  71.    NAME
  72.     ER_ChangeRequestSize -- Resizes a requester
  73.  
  74.    SYNOPSIS
  75.     ER_ChangeRequestSize(req, w, h)
  76.                          A0   D0 D1
  77.  
  78.     void ER_ChangeRequestSize(ER_RequestPtr, WORD, WORD)
  79.  
  80.    FUNCTION
  81.     Changes the size of a requester to the given dimensions. The values
  82.     are clipped to the maximum and minimum requester size, so no harm can
  83.     be done. If the requester is not currently open, it will open up in
  84.     this size the next time it is used.
  85.  
  86.    INPUTS
  87.     req      : requester to be resized
  88.     w,h      : new width and height
  89.  
  90.    RESULT
  91.  
  92.    SEE ALSO
  93.  
  94.  
  95. egsrequest.library/ER_CreateFileReq       egsrequest.library/ER_CreateFileReq
  96.  
  97.    NAME
  98.     ER_CreateFileReq -- create an filerequester
  99.  
  100.    SYNOPSIS
  101.     ER_CreateFileReq(con)
  102.                      A0
  103.  
  104.     ER_FileRequestPtr ER_CreateFileReq(ER_ReqContextPtr)
  105.  
  106.    FUNCTION
  107.     Creates a filerequester, associated to the given requester context,
  108.     or to none if 'con' equals NULL. The requester is not immediately
  109.     opened. You can open it using 'ER_OpenRequest' or 'ER_DoRequest'. If
  110.     the request is finished you find the results in the appropriate
  111.     structure elements. (see the includes for more information) You may
  112.     reuse a file requester as often as you like.
  113.  
  114.    INPUTS
  115.     con    : Requester context, in which the filerequest shall become a member.
  116.        If NULL, the requester will be a free citizen.
  117.  
  118.    RESULT
  119.     freq   : a fully initialized file requester
  120.  
  121.    SEE ALSO
  122.  
  123.  
  124. egsrequest.library/ER_CreateFontReq       egsrequest.library/ER_CreateFontReq
  125.  
  126.    NAME
  127.     ER_CreateFontReq -- 
  128.  
  129.    SYNOPSIS
  130.     ER_CreateFontReq(con)
  131.                      A0
  132.  
  133.     ER_FontReqPtr ER_CreateFontReq(ER_ReqContextPtr)
  134.  
  135.    FUNCTION
  136.  
  137.    INPUTS
  138.     con          - 
  139.  
  140.    RESULT
  141.  
  142.    SEE ALSO
  143.  
  144.  
  145. egsrequest.library/ER_CreateReqContext egsrequest.library/ER_CreateReqContext
  146.  
  147.    NAME
  148.     ER_CreateReqContext -- create a requester context
  149.  
  150.    SYNOPSIS
  151.     ER_CreateReqContext()
  152.     
  153.  
  154.     ER_ReqContextPtr ER_CreateReqContext(void)
  155.  
  156.    FUNCTION
  157.     Creates a requester context. You can use it, to keep track of your
  158.     requester and make life much easier.
  159.  
  160.    INPUTS
  161.  
  162.    RESULT
  163.     con   : an initialized requster context
  164.  
  165.    SEE ALSO
  166.  
  167.  
  168. egsrequest.library/ER_CreateScrModeReq egsrequest.library/ER_CreateScrModeReq
  169.  
  170.    NAME
  171.     ER_CreateScrModeReq -- 
  172.  
  173.    SYNOPSIS
  174.     ER_CreateScrModeReq(con)
  175.                         A0
  176.  
  177.     ER_ScrModeReqPtr ER_CreateScrModeReq(ER_ReqContextPtr)
  178.  
  179.    FUNCTION
  180.  
  181.    INPUTS
  182.     con          - 
  183.  
  184.    RESULT
  185.  
  186.    SEE ALSO
  187.  
  188.  
  189. egsrequest.library/ER_CreateSimpleReq   egsrequest.library/ER_CreateSimpleReq
  190.  
  191.    NAME
  192.     ER_CreateSimpleReq -- creates a simple requester
  193.  
  194.    SYNOPSIS
  195.     ER_CreateSimpleReq(con, names, selects)
  196.                        A0   A1     A2
  197.  
  198.     ER_SimpleReqPtr ER_CreateSimpleReq(ER_ReqContextPtr, char *, char *)
  199.  
  200.    FUNCTION
  201.     Creates a simple requester. Such a requester is build out of an
  202.     information field and a number of action gadgets. The text and the
  203.     names of the gadgets are defined in strings. Lines/Gadgets can be
  204.     separated by "|". After the request is finished, the number of the
  205.     chosen gadget is found in the requester structure. The gadgets are
  206.     numbered from left to right, starting with 0 for the first gadget.
  207.     The requester is not instantly opened. It can be displayed using
  208.     'ER_DoRequest' or 'ER_OpenRequest'. You may reuse a simple requester
  209.     as often as you like.
  210.  
  211.    INPUTS
  212.     con    : Requester context, in which the simple request shall become a member.
  213.        If NULL, the requester will be a free citizen.
  214.     texts  : contents of the body text.
  215.     selects: names of the gadgets
  216.  
  217.    RESULT
  218.     sreq   : a fully initialized simple request structure
  219.  
  220.    EXAMPLE
  221.     An call of
  222.  
  223.     ... ER_CreateSimpleRequest(NULL,"This is not|a known file|format",
  224.                   "Retry|Define|Cancel");
  225.  
  226.     will result in a requester shaped like this:
  227.  
  228.     ###---------------------###-###
  229.     ###---------------------###-###
  230.     |+---------------------------+|
  231.     ||        This is not        ||
  232.     ||       a known file        ||
  233.     ||          format.          ||
  234.     |+---------------------------+|
  235.     |+-------++--------++--------+|
  236.     || Retry || Define || Cancel ||
  237.     |+-------++--------++--------+|
  238.     +-----------------------------#
  239.  
  240.    SEE ALSO
  241.  
  242.  
  243. egsrequest.library/ER_DeleteReqContext egsrequest.library/ER_DeleteReqContext
  244.  
  245.    NAME
  246.     ER_DeleteReqContext -- delete a requester context
  247.  
  248.    SYNOPSIS
  249.     ER_DeleteReqContext(con)
  250.                         A0
  251.  
  252.     void ER_DeleteReqContext(ER_ReqContextPtr)
  253.  
  254.    FUNCTION
  255.     Deletes a requester context AND ALL associated requesters. Pending
  256.     requesters are canceled, so make sure not to wait for them to finish
  257.     or to reuse them. You can keep track of your requesters in a
  258.     requester context, and use this function to delete them all in case
  259.     of fire or exit.
  260.  
  261.    INPUTS
  262.     con      : the requester context to be deleted
  263.  
  264.    RESULT
  265.  
  266.    SEE ALSO
  267.  
  268.  
  269. egsrequest.library/ER_DeleteRequest       egsrequest.library/ER_DeleteRequest
  270.  
  271.    NAME
  272.     ER_DeleteRequest -- delete a requester
  273.  
  274.    SYNOPSIS
  275.     ER_DeleteRequest(req)
  276.                      A0
  277.  
  278.     void ER_DeleteRequest(ER_RequestPtr)
  279.  
  280.    FUNCTION
  281.     Deletes a requester (any kind). If the request is still pending, it
  282.     is canceled and the window closed.
  283.  
  284.    INPUTS
  285.     req     : the requester to be deleted
  286.  
  287.    RESULT
  288.  
  289.    SEE ALSO
  290.  
  291.  
  292. egsrequest.library/ER_DoRequest               egsrequest.library/ER_DoRequest
  293.  
  294.    NAME
  295.     ER_DoRequest -- open and start a request
  296.  
  297.    SYNOPSIS
  298.     ER_DoRequest(req)
  299.                  A0
  300.  
  301.     LONG ER_DoRequest(ER_RequestPtr)
  302.  
  303.    FUNCTION
  304.     Opens a request, and starts to handle it events. This call does only
  305.     return if the requester was not successfully opened, or after the
  306.     request is finished.
  307.  
  308.    INPUTS
  309.     req     : requester to be requested
  310.  
  311.    RESULT
  312.     done    : true, if the request was successfull
  313.  
  314.    SEE ALSO
  315.  
  316.  
  317. egsrequest.library/ER_FindRequest           egsrequest.library/ER_FindRequest
  318.  
  319.    NAME
  320.     ER_FindRequest -- find a request in a context
  321.  
  322.    SYNOPSIS
  323.     ER_FindRequest(con, msg)
  324.                    A0   A1
  325.  
  326.     ER_RequestPtr ER_FindRequest(ER_ReqContextPtr, EI_EIntuiMsgPtr)
  327.  
  328.    FUNCTION
  329.     Searches in a request context for a requester, that fits to the
  330.     message. If none is found this call returns NULL. You can use this
  331.     function to easily determine for which requester (or none at all) the
  332.     message was send.
  333.  
  334.    INPUTS
  335.     con       : a requester context, that may contain the requester
  336.     msg       : a message that might be for a requester
  337.  
  338.    RESULT
  339.     req       : the fitting requester or NULL if none fits
  340.  
  341.    SEE ALSO
  342.  
  343.  
  344. egsrequest.library/ER_IterateRequest     egsrequest.library/ER_IterateRequest
  345.  
  346.    NAME
  347.     ER_IterateRequest -- iterates a requester
  348.  
  349.    SYNOPSIS
  350.     ER_IterateRequest(req, msg)
  351.                       A0   A1
  352.  
  353.     LONG ER_IterateRequest(ER_RequestPtr, EI_EIntuiMsgPtr)
  354.  
  355.    FUNCTION
  356.     Iterates a requester according to an intui message. If it is called
  357.     with a NULL requester, or a message that does not fit to the
  358.     requester, this is a no operation. If the message terminates the
  359.     requester (e.g 'OK') this function will return false.
  360.  
  361.    INPUTS
  362.     req         : a requester that should fit to the message
  363.     msg         : an intui message received through the main port
  364.  
  365.    RESULT
  366.     notFinished : false if the requester is terminated
  367.  
  368.    SEE ALSO
  369.  
  370.  
  371. egsrequest.library/ER_OpenRequest           egsrequest.library/ER_OpenRequest
  372.  
  373.    NAME
  374.     ER_OpenRequest -- open a request an return
  375.  
  376.    SYNOPSIS
  377.     ER_OpenRequest(req, win)
  378.                    A0   A1
  379.  
  380.     LONG ER_OpenRequest(ER_RequestPtr, EI_WindowPtr)
  381.  
  382.    FUNCTION
  383.     Opens a requester and returns immediately. If the requester could
  384.     not be opened (for any reasons) this call returns false. You have to
  385.     iterate the request by using 'ER_IterateRequest'. If you supply a
  386.     window, the requester will share its port and screen. The requester
  387.     is closed, if the iteration yields in a termination, or a call to
  388.     'ER_CancelRequest'. If the requester is allready open, this is a no
  389.     operation.
  390.  
  391.    INPUTS
  392.     req        : requester to be opened
  393.     win        : a window, to share its port and screen, or NULL for the
  394.            port and screen defined in the request structure
  395.  
  396.    RESULT
  397.     success    : true if the requester couldt be opened
  398.  
  399.    SEE ALSO
  400.  
  401.  
  402. egsrequest.library/ER_PutValuesInFileReqegsrequest.library/ER_PutValuesInFileReq
  403.  
  404.    NAME
  405.     ER_PutValuesInFileReq -- put values in file requester
  406.  
  407.    SYNOPSIS
  408.     ER_PutValuesInFileReq(freq, name, path, pattern)
  409.                           A0    A1    A2    A3
  410.  
  411.     void ER_PutValuesInFileReq(ER_FileRequestPtr, char *, char *, char *)
  412.  
  413.    FUNCTION
  414.     Changes the name, path and/or pattern values of a file requester. If
  415.     the requester is opened, the change takes place immediately,
  416.     otherwise the requester will pop up with the new values, the next
  417.     time it is used. NULL values for either parameter will not affect the
  418.     original values.
  419.  
  420.    INPUTS
  421.     freq     : the filerequester to be changed
  422.     name     : a new name string or NULL
  423.     path     : a new path string or NULL
  424.     pattern  : a new pattern string or NULL
  425.  
  426.    RESULT
  427.  
  428.    SEE ALSO
  429.  
  430.  
  431. egsrequest.library/ER_PutValuesInFontReqegsrequest.library/ER_PutValuesInFontReq
  432.  
  433.    NAME
  434.     ER_PutValuesInFontReq -- 
  435.  
  436.    SYNOPSIS
  437.     ER_PutValuesInFontReq(freq, attr)
  438.                           A0    A1
  439.  
  440.     void ER_PutValuesInFontReq(ER_FontReqPtr, struct TextAttr *)
  441.  
  442.    FUNCTION
  443.  
  444.    INPUTS
  445.     freq         - 
  446.     attr         - 
  447.  
  448.    RESULT
  449.  
  450.    SEE ALSO
  451.  
  452.  
  453. egsrequest.library/ER_PutValuesInScrModeReqegsrequest.library/ER_PutValuesInScrModeReq
  454.  
  455.    NAME
  456.     ER_PutValuesInScrModeReq -- 
  457.  
  458.    SYNOPSIS
  459.     ER_PutValuesInScrModeReq(smreq, mode, depth)
  460.                              A0     A1    D0
  461.  
  462.     void ER_PutValuesInScrModeReq(ER_ScrModeReqPtr, char *, WORD)
  463.  
  464.    FUNCTION
  465.  
  466.    INPUTS
  467.     smreq        - 
  468.     mode         - 
  469.     depth        - 
  470.  
  471.    RESULT
  472.  
  473.    SEE ALSO
  474.  
  475.  
  476.